Prevents body scroll when Dialog is open #3547
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 85b0390 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
I'm not sure if this solution is SSR-compatible or not. I tried doing this with CSS using |
|
One caveat: this probably won't work on any scrollable elements within the body. |
size-limit report 📦
|
joshblack
approved these changes
Jul 24, 2023
siddharthkp
reviewed
Jul 25, 2023
src/Dialog/Dialog.tsx
Outdated
| document.body.style.overflow = 'hidden' | ||
|
|
||
| return () => { | ||
| document.body.style.overflow = '' |
There was a problem hiding this comment.
Not blocking: should we keep a track of what it was set to before and reset to that, just in case it was scroll or clip instead of the default visible?
There was a problem hiding this comment.
Sure, I'll update it.
This was referenced Jul 26, 2023
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Sets
bodytooverflow: hiddenwhen a Dialog is mounted.Closes https://github.com/github/primer/issues/2354
How to test:
Add this line to a story:
Merge checklist
Take a look at the What we look for in reviews section of the contributing guidelines for more information on how we review PRs.